/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot;

import java.util.List;
import java.util.Set;

/**
 * 提供访问运行 {@link SpringApplication} 时使用的参数的能力。
 *
 * @author Phillip Webb
 * @since 1.3.0
 */
public interface ApplicationArguments {

	/**
	 * 返回传递给应用程序的原始未处理参数。
	 * @return 参数数组
	 */
	String[] getSourceArgs();

	/**
	 * 返回所有选项参数的名称。例如，如果参数为 "--foo=bar --debug"，则返回 {@code ["foo", "debug"]}。
	 * @return 选项名称集合，如果没有则返回空集合
	 */
	Set<String> getOptionNames();

	/**
	 * 判断解析出的选项参数中是否包含指定名称的选项。
	 * @param name 要检查的名称
	 * @return 如果包含指定名称的选项则返回 {@code true}
	 */
	boolean containsOption(String name);

	/**
	 * 返回与指定名称的选项参数相关联的值集合。
	 * <ul>
	 * <li>如果选项存在但没有值（如 "--foo"），返回空集合（{@code []}）</li>
	 * <li>如果选项存在且有一个值（如 "--foo=bar"），返回一个包含一个元素的集合（{@code ["bar"]}）</li>
	 * <li>如果选项存在且有多个值（如 "--foo=bar --foo=baz"），返回包含多个值的集合（{@code ["bar", "baz"]}）</li>
	 * <li>如果选项不存在，返回 {@code null}</li>
	 * </ul>
	 * @param name 选项名称
	 * @return 指定选项名称的值集合
	 */
	List<String> getOptionValues(String name);

	/**
	 * 返回解析出的非选项参数集合。
	 * @return 非选项参数集合，如果没有则返回空列表
	 */
	List<String> getNonOptionArgs();

}
